Skip to content

AGENTS.md: record test-running, PR, and code-style conventions#535

Merged
andiwand merged 3 commits into
mainfrom
agents-conventions
Jun 14, 2026
Merged

AGENTS.md: record test-running, PR, and code-style conventions#535
andiwand merged 3 commits into
mainfrom
agents-conventions

Conversation

@andiwand

@andiwand andiwand commented Jun 14, 2026

Copy link
Copy Markdown
Member

🤖 Generated with Claude Code

Adds a few working conventions to the root AGENTS.md:

  • Build dir: use cmake-build-relwithdebinfo as the default build/test directory (not cmake-build-debug).
  • Tests: run the full suite only when really necessary (it is slow) — prefer a targeted --gtest_filter; run the test binary from the build directory so its output stays out of the repo tree.
  • Debugging: prefer the translate CLI on a single file over the test suite to reproduce/inspect behaviour quickly.
  • PRs: put the "Generated with Claude Code" line at the top of the PR body (as here).
  • Types: prefer fixed-width <cstdint> types (std::uint8_t, …) over unsigned char / unsigned / long & co when width matters.
  • Doc comments: use /// on functions/classes/structs/enums and a trailing ///< for same-line notes (kept terse).

andiwand and others added 3 commits June 14, 2026 22:33
- run the full test suite only when necessary (it is slow); prefer targeted
  --gtest_filter, and run the test binary from the build dir so its output
  does not pollute the repo
- put the "Generated with Claude Code" line at the top of PR bodies
- prefer fixed-width <cstdint> types over unsigned char / long & co
- document with /// doc comments (and trailing ///< for same-line notes)

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@andiwand andiwand enabled auto-merge (squash) June 14, 2026 20:47
@andiwand andiwand disabled auto-merge June 14, 2026 21:53
@andiwand andiwand merged commit ea3b3bf into main Jun 14, 2026
10 of 11 checks passed
@andiwand andiwand deleted the agents-conventions branch June 14, 2026 21:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant